cURL

curl --request GET \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50"
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer <token>']);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50", nil)
    req.Header.Add("Authorization", "Bearer <token>")
    response, _ := http.DefaultClient.Do(req)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50')
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "collection": [
    {
      "type": "SlottingRule",
      "id": 42,
      "rule_set": {
        "type": "SlottingRuleSet",
        "id": 19
      },
      "name": "Regulated aerosols require Hazmat storage",
      "relation": "require",
      "strength": null,
      "priority": 75,
      "merchant_ids": [
        2,
        7
      ],
      "product_profile_ids": [
        12
      ],
      "product_profile_match_mode": "any",
      "handling_class_ids": [
        4
      ],
      "merchants": [
        {
          "type": "Merchant",
          "id": 2
        },
        {
          "type": "Merchant",
          "id": 7
        }
      ],
      "product_profiles": [
        {
          "type": "ProductProfile",
          "id": 12
        }
      ],
      "handling_classes": [
        {
          "type": "HandlingClass",
          "id": 4
        }
      ],
      "location_profile": {
        "type": "LocationProfile",
        "id": 26
      },
      "subject_readable": "Merchants: Retail Direct, Marketplace; Product Profile: Regulated Aerosols; Handling Class: Hazmat",
      "location_match_readable": "zone_id in [4] && is_pickable",
      "has_conflicts": false,
      "conflict_detail": null,
      "created_at": "2026-08-10T10:45:00Z",
      "updated_at": "2026-08-10T10:45:00Z"
    }
  ],
  "included": {
    "SlottingRuleSet": [
      {
        "type": "SlottingRuleSet",
        "id": 19,
        "name": "Regulated Goods Storage",
        "is_active": true
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 26,
        "name": "Cold Storage Pick Faces",
        "status": "ready",
        "member_count": 486
      }
    ]
  },
  "has_more": false,
  "next": null,
  "previous": null,
  "meta": {
    "processing_time": 0.0091,
    "cursor_start": null,
    "cursor_end": null
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

Slotting Rules

List Slotting Rules

Returns cursor-paged Rules belonging to one Rule Set in the referenced warehouse. Product subjects keep their writable ID fields. An editor can additionally request fields=merchants,product_profiles,handling_classes with minimal nested fields such as fields:product_profiles=name,code to resolve only the selected objects through included. Load complete choice lists from their owning paged endpoints rather than from every Rule row. Conflict fields are the latest durable asynchronous detector result.

GET

inventory

warehouses

{id}

slotting-rule-sets

{rule_set_id}

rules

cURL

curl --request GET \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50"
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer <token>']);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50", nil)
    req.Header.Add("Authorization", "Bearer <token>")
    response, _ := http.DefaultClient.Do(req)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count&limit=50')
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "collection": [
    {
      "type": "SlottingRule",
      "id": 42,
      "rule_set": {
        "type": "SlottingRuleSet",
        "id": 19
      },
      "name": "Regulated aerosols require Hazmat storage",
      "relation": "require",
      "strength": null,
      "priority": 75,
      "merchant_ids": [
        2,
        7
      ],
      "product_profile_ids": [
        12
      ],
      "product_profile_match_mode": "any",
      "handling_class_ids": [
        4
      ],
      "merchants": [
        {
          "type": "Merchant",
          "id": 2
        },
        {
          "type": "Merchant",
          "id": 7
        }
      ],
      "product_profiles": [
        {
          "type": "ProductProfile",
          "id": 12
        }
      ],
      "handling_classes": [
        {
          "type": "HandlingClass",
          "id": 4
        }
      ],
      "location_profile": {
        "type": "LocationProfile",
        "id": 26
      },
      "subject_readable": "Merchants: Retail Direct, Marketplace; Product Profile: Regulated Aerosols; Handling Class: Hazmat",
      "location_match_readable": "zone_id in [4] && is_pickable",
      "has_conflicts": false,
      "conflict_detail": null,
      "created_at": "2026-08-10T10:45:00Z",
      "updated_at": "2026-08-10T10:45:00Z"
    }
  ],
  "included": {
    "SlottingRuleSet": [
      {
        "type": "SlottingRuleSet",
        "id": 19,
        "name": "Regulated Goods Storage",
        "is_active": true
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 26,
        "name": "Cold Storage Pick Faces",
        "status": "ready",
        "member_count": 486
      }
    ]
  },
  "has_more": false,
  "next": null,
  "previous": null,
  "meta": {
    "processing_time": 0.0091,
    "cursor_start": null,
    "cursor_end": null
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the referenced Warehouse.

rule_set_id

integer<int32>

required

The id of the referenced SlottingRuleSet.

Query Parameters

fields

enum<string>[]

Specify fields of the SlottingRule object to include in the response.

Available options:

all,

rule_set,

name,

relation,

strength,

priority,

merchant_ids,

merchants,

product_profile_ids,

product_profiles,

product_profile_match_mode,

handling_class_ids,

handling_classes,

location_profile,

subject_readable,

location_match_readable,

has_conflicts,

conflict_detail,

created_at,

updated_at

fields:rule_set

enum<string>[]

Specify fields of the SlottingRuleSet object referenced by each Rule. See the selecting fields page for more information. Specify fields of the SlottingRuleSet object to include in the response.

Available options:

all,

name,

description,

is_active,

rule_count,

has_conflicts,

conflicting_rule_count,

created_at,

updated_at

fields:location_profile

enum<string>[]

Specify fields of the LocationProfile object referenced by each Rule. See the selecting fields page for more information. Specify direct display fields of an included LocationProfile object.

Available options:

name,

description,

status,

member_count,

match_readable,

created_at,

updated_at

fields:merchants

enum<string>[]

Specify direct fields of selected Merchant objects to include under included.Merchant. Add merchants to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included Merchant object.

Available options:

code,

name,

status,

created_at,

updated_at

fields:product_profiles

enum<string>[]

Specify fields of selected ProductProfile objects to include under included.ProductProfile. Add product_profiles to the root fields parameter to return the relationship. type and id are always returned. Specify fields of an included ProductProfile object.

Available options:

basic,

all,

name,

code,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:handling_classes

enum<string>[]

Specify direct fields of selected HandlingClass objects to include under included.HandlingClass. Add handling_classes to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included HandlingClass object.

Available options:

name,

code,

sort_order,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

filter

string[]

Using the filtering syntax, filter results by:

id
name
relation
strength
priority
product_profile_match_mode
location_profile_id
has_conflicts

sort

string

The default sort order is ascending by id.

The following fields are available for sorting:

id
name
relation
priority
has_conflicts
updated_at

count

integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1

cursor_end

integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

cursor_start

integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

limit

integer

default:100

Number of SlottingRule objects to return; maximum 250.

Required range: 1 <= x <= 250

Example:

50

Response

A bounded collection of Rules in the requested Rule Set.

collection

SlottingRule · object[]

Slotting Rules matching the query.

Show child attributes

included

object

Direct objects included by specifying nested fields. Relationship trees below these editor selections are never expanded. See the selecting fields page.

Show child attributes

Example:

{}

has_more

boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

string | null

The resource path for the next page of results if any are expected.

string | null

The resource path for the previous page of results if any are expected.

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

List Slotting Rules

Authorizations

Path Parameters

Query Parameters

Response